RMS Config API

The table below outlines how different parts of the Remote Management Service Config API operate and how each part can be used:

RMS V1 API Aspect	How it works	What it can be used for
Get API version/Test API connectivity	Retrieves API version information and confirms availability of the API	Determines API version for consumption and support. Receipt of a response to this call confirms API availability
Get list of Remote Management Service details associated with a product ID	Retrieves a list of Remote Managed Services available to be managed for the product ID provided	Determines the resources allocated to the Remote Management Service of the queried product
Factory Reset Device	Returns the ONT and the Remote Management Services on the ONT to its original factory configuration plus the changes specified in the RSP service templates	Used to return the ONT and the Remote Management Service to a known state
Reboot Device	Restarts the ONT device	Used to resolve service issues with the ONT
Get WAN configuration and/or statistics	Retrieves WAN configuration parameters and statistics	Used to view configuration of WAN services and diagnose WAN issues
Set WAN configuration	Updates WAN configuration parameters	Used to update WAN configuration to modify WAN behaviour and correct issues
Get LAN Ethernet ports configuration and/or Ethernet ports statistics	Retrieves LAN Ethernet Port configuration parameters and statistics	Used to view configuration of Ethernet Port services and diagnose Ethernet Port issues
Put LAN Ethernet port configuration	Sets or updates LAN ethernet port configuration parameters	Used to update Ethernet Port configuration to modify Ethernet Port behaviour and correct issues
Get LAN DHCP & IP configuration	Retrieves LAN DHCP & IP configurations from the ONT device	Used to view configuration of LAN services and diagnose LAN issues
Set LAN DHCP & IP configuration	Sets or updates LAN DHCP & IP configurations from the ONT device	Used to update LAN configuration to modify LAN behaviour and correct issues
Get LAN Static IP Address configuration	Retrieves LAN Static IP Address configuration from the ONT device	Used to view LAN Static IP Address configuration settings
Set LAN Static IP Address configuration	Sets or updates LAN Static IP Address on the ONT device	Used to change Static IP Address configuration settings
Get LAN hosts information	Retrieves LAN hosts from the ONT device	Used to view all devices currently connected to the ONT’s local networks
Reset a LAN Ethernet port	Restarts an Ethernet port on the ONT	Used to restart an Ethernet port and reapply it’s configuration settings.
Get WiFi ports configuration, port statistics, devices, and/or device statistics information	Retrieves WiFi port configuration, port statistics, connected devices, and/or device statistics information from the ONT	Used to view configuration of WiFi services and diagnose WiFi issues
Set WiFi port configuration	Updates WiFi port configurations on the ONT device	Used to update WiFi configuration to modify WiFi behaviour and correct issues
Reset a WiFi port	Updates WiFi port configurations on the ONT device	Used to restart a WiFi port and reapply its configuration settings
Get voice profiles and/or ports configuration, and/or port statistics information	Retrieves voice profiles and/or ports configuration, and/or port statistics information from the ONT device	Used to determine current voice profile, port configuration settings and statistics for issue resolution
Set voice profile configuration	Updates voice profile configurations on the ONT device	Used to provision or correct voice profile configurations
Set voice port configuration	Updates voice port configurations on the ONT device	Used to provision or correct voice port configurations
Reset Voice Profile	Updates voice profile configurations on the ONT device	Used to provision or correct voice profile configurations
Reload the voice profile and port configuration and restart all voice components	Updates voice profile and port configurations on the ONT device and restarts voice components	Used to correct voice profile configurations
Reset Voice Port	Updates voice port configurations on the ONT device	Used to provision or correct voice profile configurations
Set ONT admin credentials (Set Username and/or password)	Updates admin credentials on the ONT device	Used to enable support and resolve support access issues
Get port forwarding rules	Retrieves current port forwarding rules from the ONT device	Used to determine current port forwarding rules for issue resolution
Set port forwarding rules	Updates port forwarding rules	Used to provision or correct port forwarding rules
Get firewall configuration	Retrieves firewall configurations from the ONT device	Used to determine current firewall configuration to diagnose issues
Set firewall configuration	Updates firewall configurations	Used to provision or correct firewall configurations

For detailed information regards the information sent to and received from the Remote Managed Services API please refer to the schema tabs of the Remote Manage Service API – Workbook – v1-2.xlsm